package vip.liux.contracts.infrastructure.pay;


import vip.liux.contracts.infrastructure.pay.dto.order.ClientPayOrderDto;
import vip.liux.contracts.infrastructure.pay.dto.order.PayOrderUnifiedDto;
import vip.liux.contracts.infrastructure.pay.dto.refund.ClientPayRefundDto;
import vip.liux.contracts.infrastructure.pay.dto.refund.PayRefundUnifiedDto;
import vip.liux.contracts.infrastructure.pay.dto.transfer.ClientPayTransferDto;
import vip.liux.contracts.infrastructure.pay.dto.transfer.PayTransferUnifiedDto;

import java.util.Map;

/**
 * 支付客户端，用于对接各支付渠道的 SDK，实现发起支付、退款等功能
 *
 * @author 芋道源码
 */
public interface PayClient<Config> {

    /**
     * 获得渠道编号
     *
     * @return 渠道编号
     */
    Long getId();

    /**
     * 获得渠道配置
     *
     * @return 渠道配置
     */
    Config getConfig();


    // ============ 支付相关 ==========

    /**
     * 调用支付渠道，统一下单
     *
     * @param reqDto 下单信息
     * @return 支付订单信息
     */
    ClientPayOrderDto unifiedOrder(PayOrderUnifiedDto reqDto);

    /**
     * 解析 order 回调数据
     *
     * @param params  HTTP 回调接口 content type 为 application/x-www-form-urlencoded 的所有参数
     * @param body    HTTP 回调接口的 request body
     * @param headers HTTP 回调接口的 request headers
     * @return 支付订单信息
     */
    ClientPayOrderDto parseOrderNotify(Map<String, String> params, String body, Map<String, String> headers);

    /**
     * 获得支付订单信息
     *
     * @param outTradeNo 外部订单号
     * @return 支付订单信息
     */
    ClientPayOrderDto getOrder(String outTradeNo);

    // ============ 退款相关 ==========

    /**
     * 调用支付渠道，进行退款
     *
     * @param reqDto 统一退款请求信息
     * @return 退款信息
     */
    ClientPayRefundDto unifiedRefund(PayRefundUnifiedDto reqDto);

    /**
     * 解析 refund 回调数据
     *
     * @param params  HTTP 回调接口 content type 为 application/x-www-form-urlencoded 的所有参数
     * @param body    HTTP 回调接口的 request body
     * @param headers HTTP 回调接口的 request headers
     * @return 支付订单信息
     */
    ClientPayRefundDto parseRefundNotify(Map<String, String> params, String body, Map<String, String> headers);

    /**
     * 获得退款订单信息
     *
     * @param outTradeNo  外部订单号
     * @param outRefundNo 外部退款号
     * @return 退款订单信息
     */
    ClientPayRefundDto getRefund(String outTradeNo, String outRefundNo);

    // ============ 转账相关 ==========

    /**
     * 调用渠道，进行转账
     *
     * @param reqDto 统一转账请求信息
     * @return 转账信息
     */
    ClientPayTransferDto unifiedTransfer(PayTransferUnifiedDto reqDto);

    /**
     * 获得转账订单信息
     *
     * @param outTradeNo 外部订单号
     * @return 转账信息
     */
    ClientPayTransferDto getTransfer(String outTradeNo);

    /**
     * 解析 transfer 回调数据
     *
     * @param params  HTTP 回调接口 content type 为 application/x-www-form-urlencoded 的所有参数
     * @param body    HTTP 回调接口的 request body
     * @param headers HTTP 回调接口的 request headers
     * @return 转账信息
     */
    ClientPayTransferDto parseTransferNotify(Map<String, String> params, String body, Map<String, String> headers);

}
